<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="PayPal,com.reyco1.services.PayPal,itemsInCart,registeredItems,configure,registerItem,checkOut,addItem,removeItem" name="keywords">
<title>com.reyco1.services.PayPal</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'PayPal - Reyco1 API Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Reyco1 AS3 Tools</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?com/reyco1/services/PayPal.html&amp;com/reyco1/services/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;PayPal</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class PayPal"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.reyco1.services</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class PayPal</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">PayPal <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="../extension/DispatchExtension.html">DispatchExtension</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
  A tool which allows you to gather information and send it to PayPal for processing.
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#itemsInCart">itemsInCart</a> : Array<div class="summaryTableDescription">[read-only]
   Returns all the items currently in the user "check out basket".</div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../extension/DispatchExtension.html#outputSilenced">outputSilenced</a> : Boolean<div class="summaryTableDescription">
   Togles the output functionality of the extending class
   </div>
</td><td class="summaryTableOwnerCol"><a href="../extension/DispatchExtension.html">DispatchExtension</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#registeredItems">registeredItems</a> : Array<div class="summaryTableDescription">[read-only]
   Returns all the registered items
   </div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#PayPal()">PayPal</a>()</div>
<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addItem()">addItem</a>($itemName:String):void</div>
<div class="summaryTableDescription">
   Adds an item to the "check out basket".</div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#checkOut()">checkOut</a>():void</div>
<div class="summaryTableDescription">
   Checks out all the items the user has added to the PayPal instance using "addItem"
   
   $eventType
   com.reyco1.events.PayPalEvent.CHECKOUT
   
   </div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#configure()">configure</a>($configObject:Object):void</div>
<div class="summaryTableDescription">
   Sets the PayPal Cart configuration
   </div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../extension/DispatchExtension.html#dispatchEvent()">dispatchEvent</a>($event:Event):Boolean</div>
<div class="summaryTableDescription">
   Overrides the dispatchEvent method in flash.events.EventDispatcher
   </div>
</td><td class="summaryTableOwnerCol"><a href="../extension/DispatchExtension.html">DispatchExtension</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../extension/DispatchExtension.html#output()">output</a>($output:*):void</div>
<div class="summaryTableDescription">
   Allows all classes which extend ClipExtension to be able to use a more detailed logging system
   </div>
</td><td class="summaryTableOwnerCol"><a href="../extension/DispatchExtension.html">DispatchExtension</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#registerItem()">registerItem</a>($itemObject:Object):void</div>
<div class="summaryTableDescription">
   Registers a purchase item to your PayPal
   </div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeItem()">removeItem</a>($itemName:String):void</div>
<div class="summaryTableDescription">
   Removes and item from the "check out basket" previosly added with the "addItem" method
   </div>
</td><td class="summaryTableOwnerCol">PayPal</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="itemsInCart"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">itemsInCart</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>itemsInCart:Array</code>&nbsp;&nbsp;[read-only]<p>
   Returns all the items currently in the user "check out basket".
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get itemsInCart():Array</code>
<br>
</div>
<a name="registeredItems"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">registeredItems</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>registeredItems:Array</code>&nbsp;&nbsp;[read-only]<p>
   Returns all the registered items
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get registeredItems():Array</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="PayPal()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">PayPal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function PayPal()</code>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addItem()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addItem($itemName:String):void</code><p>
   Adds an item to the "check out basket". This basically means that the is item is ready to be purchased
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">$itemName</span>:String</code> &mdash; name of the registered product
   
   $eventType
   com.reyco1.events.PayPalEvent.ITEM_ADDED
   
   </td>
</tr>
</table>
</div>
<a name="checkOut()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">checkOut</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function checkOut():void</code><p>
   Checks out all the items the user has added to the PayPal instance using "addItem"
   
   $eventType
   com.reyco1.events.PayPalEvent.CHECKOUT
   
   </p></div>
<a name="configure()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">configure</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function configure($configObject:Object):void</code><p>
   Sets the PayPal Cart configuration
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">$configObject</span>:Object</code> &mdash;  an object containing all the mandatory and optional values needed.
   to configure the PayPay Cart. 
   
   <p>
   Mandatory:
   <ul>
    <li>business:String  your paypal registered email address</li>
    <li>currency:String  the default currency, for example: "USD" or "GBP"</li>
   </ul>
   </p>
   
   <p>
   Optional:
   <ul>
    <li>logo:String     path to a 150x50 px logo to be used in the paypal landing page</li>
    <li>cancel_return:String  path to a page where the user will be redirected on your site if he cancels his order</li>
    <li>success_return:String  path to a page where the user will be redirected on your site when he completes his order</li>
    <li>site:String     a reference to your site</li>
   </ul>
   </p>
   
   </td>
</tr>
</table>
<br>
<span class="label">Example</span>
<br>
   <div class='listing'><pre>
   var myPP:payPalCart = new payPal();
   var objConfig:Object = new Object();
   
   objConfig.business = "your email address here";
   objConfig.currency = "USD";
   
   myPP.configure(objConfig);
   </pre></div>
   
   <p></p>
</div>
<a name="registerItem()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">registerItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function registerItem($itemObject:Object):void</code><p>
   Registers a purchase item to your PayPal
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">$itemObject</span>:Object</code> &mdash; An object with the mandatory "nam"e and "price" values
   
   </td>
</tr>
</table>
<br>
<span class="label">Example</span>
<br>   <div class='listing'><pre>
   myPP.registerItem({name:"Book", price:4.95})
   </pre></div>
   
   
   <p></p>
</div>
<a name="removeItem()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeItem($itemName:String):void</code><p>
   Removes and item from the "check out basket" previosly added with the "addItem" method
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">$itemName</span>:String</code> &mdash;   
   $eventType
   com.reyco1.events.PayPalEvent.ITEM_REMOVED
   
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
